#ifndef OMG_DDS_SAMPLE_HPP_
#define OMG_DDS_SAMPLE_HPP_

/* Copyright (c) 2009-2010, Real-Time Innovations, Inc.
 * Copyright (c) 2010, Object Management Group, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - Neither the names of the above copyright holders nor the names of their
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL A COPYRIGHT HOLDER OR CONTRIBUTOR BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


template <typename T, typename DELEGATE>
class dds::sub::Sample : public dds::core::Value
{
    OMG_DDS_VALUE_TYPE(Sample)

public:
    typedef T DataType;

public:
    bool is_valid_data() const;

    /**
     * @throws  InvalidDataError    If this sample does not include valid
     *                              data -- i.e. if it represents an
     *                              unregistration or disposal.
     */
    const DataType& data() const;

public:
    const dds::core::SampleState::Kind sample_state() const;
    const dds::core::ViewState::Kind view_state() const;
    const dds::core::InstanceState::Kind instance_state() const;
    
    const dds::core::Time source_timestamp() const;
    
    const dds::core::InstanceHandle instance_handle() const;
    const dds::core::InstanceHandle publication_handle() const;
    
    int32_t disposed_generation_count() const;
    int32_t no_writers_generation_count() const;
    int32_t sample_rank() const;
    int32_t generation_rank() const;
    int32_t absolute_generation_rank() const;

private:
    friend class OMG_DDS_SAMPLE_DELEGATE;
    DELEGATE impl_;
};


template <typename T, typename DELEGATE>
class dds::sub::LoanedSamples
{
public:
    typedef T DataType;
    typedef Sample<DataType> SampleType;

public:
    LoanedSamples();
    LoanedSamples(const LoanedSamples& src);
    ~LoanedSamples();   // implicitly return loan
    
public:
    class Iterator : public std::iterator<std::forward_iterator_tag, const SampleType>
    {
    public:
        Iterator();
        Iterator(const Iterator& src);
        ~Iterator();

    public:
        Iterator& operator=(const Iterator& src);
        
        bool operator==(const Iterator& other) const;
        bool operator!=(const Iterator& other) const;
        
        Iterator& operator++();     // prefix
        Iterator  operator++(int);  // postfix

        const SampleType& operator*();

        const SampleType* operator->();

    private:
        friend class OMG_DDS_LOANED_SAMPLES_ITERATOR_DELEGATE;
        OMG_DDS_LOANED_SAMPLES_ITERATOR_DELEGATE impl_;
    };
    
public:
    const Iterator begin() const;
    const Iterator end() const;

public:
    void return_loan();     // explicitly return loan

    // --- State: --- //
private:
    friend class OMG_DDS_LOANED_SAMPLES_DELEGATE;
    DELEGATE impl_;
};


#endif // !defined(OMG_DDS_SAMPLE_HPP_)
